API Version 1 0.3-beta

General Architecture Resources

Service Locations

Service locations are business entities that perform work on assets.

Create a case for an service location

Create a case for a service location in your group.

POST /service_locations/{id}/cases

Request Attributes

Name Condition Description
assetArrived optional The time at which the asset arrived at the service location.
assetCheckInTime optional The time at which the asset was checked in at the service location.
assetDepartedTime optional The time at which the asset was departed from the service location.
assetIdentifier:id optional The Decisiv Asset Id.
assetInformation:engineHours optional The engine hours of the asset when the case is created.
assetInformation:mileage optional The mileage of the asset when the case is created.
assetInformation:trailer:loaded optional The status of the trailer.
assetInformation:trailer:unitNumber optional The unit number of the trailer attached to the asset.
atr optional Actual time of repair.
authNumber optional Authorization Number.
breakdown:city optional The current location city of the asset.
breakdown:driverName optional The driver’s name.
breakdown:driverPhone optional The driver’s phone number.
breakdown:location optional The current location of the asset.
breakdown:state optional The current location state of the asset.
cause optional The description of the cause for the case.
complaint optional The description of the complaint.
confirmedAppointmentTime optional Confirmed appointment time.
correction optional The description of the resolution for the case.
customComplaintCodes:code optional A set of custom complaint codes (must be defined through Professional Services before use).
customerRequestedAppointmentTime optional The customer’s preferred appointment time.
customerRequestedCompletionTime optional The customer’s preferred completion time.
customers:billingCustomer:id optional The Billing Customer ID.
customers:shippingCustomer:id optional The Shipping Customer ID.
department:code optional The case department code.
downtime optional The time at which the asset was not operational.
etr optional Estimated time of repair.
followupTime optional The time by which the customer needs to be contacted.
invoiceAmount optional Invoice total.
invoiceDate optional Invoice Date.
invoiceNumber optional Invoice number.
poNumber optional Purchase order number.
primaryContact:email optional The email of the primary contact.
primaryContact:name optional The full name of the primary contact.
primaryContact:phone optional The phone number of the primary contact.
primaryContact:relation optional The relation of the primary contact.
programType:description optional The case program type description.
roNumber optional Repair order number.
serviceLocationSuggestedAppointmentTime optional Service location’s preferred appointment time.
status:name optional Current status of the case.
tagNumber optional Tag number for the asset on the lot.
uptime optional The time at which the asset was operational.
vmrs:code14 optional Reason for repair.
vmrs:code15 optional Work Accomplished.
vmrs:code16 optional Repair priority.
vmrs:code17 optional Repair site.
vmrs:code82 optional Operator Report.
vmrs:complaintCode33 optional Component code for the complaint.
vmrs:complaintCode79 optional Position code for the complaint.
vmrs:correctionCode33 optional Component code for the correction.
vmrs:correctionCode79 optional Position code for the correction.

Request

<?xml version="1.0" encoding="UTF-8"?>
<case xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/CaseRequest"
  xmlns:ct="http://www.decisiv.net/platform_api/0.3-beta/Case/CaseTypes"
  xmlns:g="http://www.decisiv.net/platform_api/0.2/Case/GroupedUser"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:d="http://www.decisiv.net/platform_api/0.3-beta/Case/Department"
  xmlns:pt="http://www.decisiv.net/platform_api/0.3-beta/Case/ProgramType"
  xsi:schemaLocation="http://www.decisiv.net/platform_api/0.3-beta/Case/CaseRequest">
    <ct:assetIdentifier>
      <ct:id>1234</ct:id>
    </ct:assetIdentifier>
    <assignee>
        <g:id>id0</g:id>
    </assignee>
    <primaryContact>
        <ct:name>name1</ct:name>
        <ct:phone>15558675309</ct:phone>
        <ct:email>email0</ct:email>
        <ct:relation>relation0</ct:relation>
    </primaryContact>
    <breakdown>
        <ct:driverName>Driver Name</ct:driverName>
        <ct:driverPhone>555-555-5555</ct:driverPhone>
        <ct:location>location0</ct:location>
        <ct:city>city0</ct:city>
        <ct:state>state0</ct:state>
    </breakdown>
    <assetDepartedTime>2006-05-04T18:13:51.0</assetDepartedTime>
    <assetInformation>
      <ct:engineHours>engineHours0</ct:engineHours>
      <ct:mileage>100</ct:mileage>
      <ct:trailer>
        <ct:unitNumber>unitNumber</ct:unitNumber>
        <ct:loaded>true</ct:loaded>
      </ct:trailer>
    </assetInformation>
    <cause>cause0</cause>
    <correction>correction0</correction>
    <complaint>complaint0</complaint>
    <severity>0.0</severity>
    <downtime>2006-05-04T18:13:51.0</downtime>
    <uptime>2006-05-04T18:13:51.0</uptime>
    <customerRequestedAppointmentTime>2006-05-04T18:13:51.0</customerRequestedAppointmentTime>
    <serviceLocationSuggestedAppointmentTime>2006-05-04T18:13:51.0</serviceLocationSuggestedAppointmentTime>
    <confirmedAppointmentTime>2006-05-04T18:13:51.0</confirmedAppointmentTime>
    <customerRequestedCompletionTime>2006-05-04T18:13:51.0</customerRequestedCompletionTime>
    <followupTime>2006-05-04T18:13:51.0</followupTime>
    <assetArrived>2006-05-04T18:13:51.0</assetArrived>
    <assetCheckInTime>2006-05-04T18:13:51.0</assetCheckInTime>
    <etr>2006-05-04T18:13:51.0</etr>
    <atr>2006-05-04T18:13:51.0</atr>
    <ct:status>
      <ct:name>status name</ct:name>
    </ct:status>
    <poNumber>poNumber0</poNumber>
    <roNumber>roNumber0</roNumber>
    <invoiceAmount>0.00</invoiceAmount>
    <invoiceNumber>invoiceNumber0</invoiceNumber>
    <invoiceDate>2016-04-21</invoiceDate>
    <authNumber>authNumber0</authNumber>
    <tagNumber>tagNumber0</tagNumber>
    <department>
      <d:code>code0</d:code>
    </department>
    <programType>
      <pt:description>description0</pt:description>
    </programType>
    <customers>
      <billingCustomer>
        <ct:id>billingCustomer0</ct:id>
      </billingCustomer>
      <shippingCustomer>
        <ct:id>shippingCustomer0</ct:id>
      </shippingCustomer>
    </customers>
</case>

Response Attributes

Name Value
assetArrived The time at which the asset arrived at the service location.
assetCheckInTime The time at which the asset was checked in at the service location.
assetDepartedTime The time at which the asset was departed from the service location.
assetInformation:engineHours The engine hours of the asset when the case is created.
assetInformation:mileage The mileage of the asset when the case is created.
assetInformation:trailer:loaded The status of the trailer.
assetInformation:trailer:unitNumber The unit number of the trailer attached to the asset.
assignee:groupName The group name for the assignee.
assignee:id The assignee of the case when created.
assignee:name The name of the assignee.
assignee:url The Assignee URL.
atr Actual time of repair.
attachmentsURL The Cases attachments url.
authNumber Authorization Number.
billingCustomerURL The Billing Customer URL.
breakdown:city The current location city of the asset.
breakdown:driverName The driver’s name.
breakdown:driverPhone The driver’s phone number.
breakdown:location The current location of the asset.
breakdown:state The current location state of the asset.
cause The description of the cause for the case.
closed Identifies whether the Case is Closed or not.
closeURL The URL to Close the Case.
complaint The description of the complaint.
confirmedAppointmentTime Confirmed appointment time.
coreTotal The total cost for Core parts.
correction The description of the resolution for the case.
createdAt The date the record was created.
customComplaintCodes:code A set of custom complaint codes (must be defined through Professional Services before use).
customerRequestedAppointmentTime The customer’s preferred appointment time.
customerRequestedCompletionTime The customer’s preferred completion time.
customers:billingCustomer:id The Billing Customer ID.
customers:billingCustomer:companyName The Billing Customer company name.
customers:billingCustomer:externalID The Billing Customer external identifier.
customers:customer:id The Customer ID.
customers:customer:companyName The Customer company name.
customers:customer:externalID The Customer external identifier.
customers:shippingCustomer:id The Shipping Customer ID.
customers:shippingCustomer:companyName The Shipping Customer company name.
customers:shippingCustomer:externalID The Shipping Customer external identifier.
customerURL The Customer URL.
department:code The case department code.
department:description The case department description.
downtime The time at which the asset was not operational.
estimateURL The Estimate URL.
etr Estimated time of repair.
followupTime The time by which the customer needs to be contacted.
freight The cost for Freight.
hazWaste The cost for Hazardous Waste.
id The numerical record id.
invoiceAmount Invoice total.
invoiceDate Invoice Date.
invoiceNumber Invoice number.
laborTotal The total cost for Labor.
notesURL The Case notes URL.
openURL The URL to Open the Case.
originationEvent The origination of the Event.
parentCaseURL The Parent Case URL.
partsTotal The total cost for Parts.
poNumber Purchase order number.
primaryContact:caseRecipientId The Decisv Portal user id for the primary contact.
primaryContact:email The email of the primary contact.
primaryContact:name The full name of the primary contact.
primaryContact:phone The phone number of the primary contact.
primaryContact:relation The relation of the primary contact.
programType:description The case program type description.
roNumber Repair order number.
serviceLocationSuggestedAppointmentTime Service location’s preferred appointment time.
serviceLocationURL The Service Location URL.
severity A decimal value indicating the severity of the estimate.
shippingCustomerURL The Shipping Customer URL.
shopSupplies The cost of the Shop Supplies.
status:name Current status of the case.
subcasesURL The Subcases URL.
tagNumber Tag number for the asset on the lot.
tax The amount of tax charged.
total The accumulated total.
updatedAt The date the record was last updated.
uptime The time at which the asset was operational.
URL The object URL.
uuid the unique identifier of the object.
vmrs:code14 Reason for repair.
vmrs:code15 Work Accomplished.
vmrs:code16 Repair priority.
vmrs:code17 Repair site.
vmrs:code82 Operator Report.
vmrs:complaintCode33 Component code for the complaint.
vmrs:complaintCode79 Position code for the complaint.
vmrs:correctionCode33 Component code for the correction.
vmrs:correctionCode79 Position code for the correction.

Response

<case xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/CaseResponse"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:ct="http://www.decisiv.net/platform_api/0.3-beta/Case/CaseTypes"
  xmlns:g="http://www.decisiv.net/platform_api/0.2/Case/GroupedUser"
  xmlns:d="http://www.decisiv.net/platform_api/0.3-beta/Case/Department"
  xmlns:pt="http://www.decisiv.net/platform_api/0.3-beta/Case/ProgramType"
  xmlns:vmrs="http://www.decisiv.net/platform_api/0.2/Case/VMRS">
    <id>id0</id>
    <uuid>uuid0</uuid>
    <URL>URL0</URL>
    <estimateURL>estimateURL</estimateURL>
    <parentCaseURL>parentCaseURL0</parentCaseURL>
    <assetURL>assetURL0</assetURL>
    <customerURL>customerURL0</customerURL>
    <billingCustomerURL>billingCustomerURL0</billingCustomerURL>
    <shippingCustomerURL>shippingCustomerURL0</shippingCustomerURL>
    <serviceLocationURL>serviceLocationURL0</serviceLocationURL>
    <notesURL>notesURL0</notesURL>
    <attachmentsURL>attachmentsURL0</attachmentsURL>
    <subcasesURL>subcasesURL0</subcasesURL>
    <closeURL>closeURL0</closeURL>
    <openURL>openURL0</openURL>
    <assetDepartedTime>2006-05-04T18:13:51.0</assetDepartedTime>
    <assignee>
        <g:id>id0</g:id>
        <g:URL>url0</g:URL>
        <g:name>name0</g:name>
        <g:groupName>groupName0</g:groupName>
    </assignee>
    <primaryContact>
        <ct:caseRecipientId>caseRecipientId1</ct:caseRecipientId>
        <ct:name>name1</ct:name>
        <ct:phone>15558675309</ct:phone>
        <ct:email>email0</ct:email>
        <ct:relation>relation0</ct:relation>
    </primaryContact>
    <breakdown>
        <ct:driverName>driver name</ct:driverName>
        <ct:driverPhone>555-555-5555</ct:driverPhone>
        <ct:location>location0</ct:location>
        <ct:city>city0</ct:city>
        <ct:state>state0</ct:state>
    </breakdown>
    <ct:assetInformation>
        <ct:engineHours>engineHours0</ct:engineHours>
        <ct:mileage>100</ct:mileage>
        <ct:trailer>
            <ct:unitNumber>unitNumber0</ct:unitNumber>
            <ct:loaded>false</ct:loaded>
        </ct:trailer>
    </assetInformation>
    <cause>cause0</cause>
    <correction>correction0</correction>
    <complaint>complaint0</complaint>
    <severity>0.0</severity>
    <originationEvent>originationEvent0</originationEvent>
    <downtime>2006-05-04T18:13:51.0</downtime>
    <uptime>2006-05-04T18:13:51.0</uptime>
    <customerRequestedAppointmentTime>2006-05-04T18:13:51.0</customerRequestedAppointmentTime>
    <serviceLocationSuggestedAppointmentTime>2006-05-04T18:13:51.0</serviceLocationSuggestedAppointmentTime>
    <confirmedAppointmentTime>2006-05-04T18:13:51.0</confirmedAppointmentTime>
    <customerRequestedCompletionTime>2006-05-04T18:13:51.0</customerRequestedCompletionTime>
    <followupTime>2006-05-04T18:13:51.0</followupTime>
    <assetArrived>2006-05-04T18:13:51.0</assetArrived>
    <assetCheckInTime>2006-05-04T18:13:51.0</assetCheckInTime>
    <etr>2006-05-04T18:13:51.0</etr>
    <atr>2006-05-04T18:13:51.0</atr>
    <ct:status>
        <ct:name>name4</ct:name>
    </ct:status>
    <poNumber>poNumber0</poNumber>
    <roNumber>roNumber0</roNumber>
    <invoiceAmount>0.00</invoiceAmount>
    <invoiceNumber>invoiceNumber0</invoiceNumber>
    <invoiceDate>2016-04-21</invoiceDate>
    <authNumber>authNumber0</authNumber>
    <tagNumber>tagNumber0</tagNumber>
    <ct:customComplaintCodes>
      <ct:code>001158</ct:code>
      <ct:code>005599</ct:code>
    </ct:customComplaintCodes>
    <vmrs>
        <vmrs:code14>
            <vmrs:code>01</vmrs:code>
            <vmrs:description>01 description</vmrs:description>
        </vmrs:code14>
        <vmrs:code15>
            <vmrs:code>01</vmrs:code>
            <vmrs:description>code 01 description</vmrs:description>
        </vmrs:code15>
        <vmrs:code16>
            <vmrs:code>1</vmrs:code>
            <vmrs:description>code 1 description</vmrs:description>
        </vmrs:code16>
        <vmrs:code17>
            <vmrs:code>1</vmrs:code>
            <vmrs:description>code 1 description</vmrs:description>
        </vmrs:code17>
        <vmrs:complaintCode33>
            <vmrs:code>001</vmrs:code>
            <vmrs:description>code 001 description</vmrs:description>
        </vmrs:complaintCode33>
        <vmrs:correctionCode33>
            <vmrs:code>001</vmrs:code>
            <vmrs:description>001 description</vmrs:description>
        </vmrs:correctionCode33>
        <vmrs:correctionCode79>
            <vmrs:code>001</vmrs:code>
            <vmrs:description>001 description</vmrs:description>
        </vmrs:correctionCode79>
        <vmrs:code82>
            <vmrs:code>001</vmrs:code>
            <vmrs:description>code 001 description</vmrs:description>
            <vmrs:code>002</vmrs:code>
            <vmrs:description>code 002 description</vmrs:description>
        </vmrs:code82>
    </vmrs>
    <department>
      <d:code>code0</d:code>
      <d:description>description0</d:description>
    </department>
    <programType>
      <pt:description>description0</pt:description>
    </programType>
    <customers>
      <customer>
        <ct:id>id0</ct:id>
        <ct:companyName>company0</ct:companyName>
        <ct:externalID>externalID0</ct:externalID>
      </customer>
      <billingCustomer>
        <ct:id>id1</ct:id>
        <ct:companyName>company1</ct:companyName>
        <ct:externalID>externalID1</ct:externalID>
      </billingCustomer>
      <shippingCustomer>
        <ct:id>id2</ct:id>
        <ct:companyName>company2</ct:companyName>
        <ct:externalID>externalID2</ct:externalID>
      </shippingCustomer>
    </customers>
    <shopSupplies>0.00</shopSupplies>
    <hazWaste>0.00</hazWaste>
    <freight>0.00</freight>
    <tax>0.00</tax>
    <partsTotal>0.00</partsTotal>
    <laborTotal>0.00</laborTotal>
    <coreTotal>0.00</coreTotal>
    <total>0.00</total>
    <closed>false</closed>
    <createdAt>2006-05-04T18:13:51.0</createdAt>
    <updatedAt>2006-05-04T18:13:51.0</updatedAt>
</case>

List departments for a service location

GET /service_locations/{id}/departments

Response

<?xml version="1.0" encoding="UTF-8"?>
<departments xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationDepartments"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:d="http://www.decisiv.net/platform_api/0.3-beta/Case/Department"
  xsi:schemaLocation="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationDepartments">
    <department xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:d="http://www.decisiv.net/platform_api/0.3-beta/Case/Department" xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationDepartments">
        <d:code>code0</d:code>
        <d:description>description0</d:description>
    </department>
    <department xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:d="http://www.decisiv.net/platform_api/0.3-beta/Case/Department" xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationDepartments">
        <d:code>code1</d:code>
        <d:description>description1</d:description>
    </department>
</departments>

Get a single department by code

GET /service_locations/{id}/departments/{code}

Response

<?xml version="1.0" encoding="UTF-8"?>
<department xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:d="http://www.decisiv.net/platform_api/0.3-beta/Case/Department" xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationDepartments">
    <d:code>code0</d:code>
    <d:description>description0</d:description>
</department>

List salesmen for a service location

GET /service_locations/{id}/salesmen

Response

<?xml version="1.0" encoding="UTF-8"?>
<salesmen xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationSalesmen" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:d="http://www.decisiv.net/platform_api/0.3-beta/Case/Salesman" xsi:schemaLocation="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationSalesmen">
    <salesman xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:s="http://www.decisiv.net/platform_api/0.3-beta/Case/Salesman" xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationSalesmen">
        <s:id>id0</s:id>
        <s:name>name0</s:name>
    </salesman>
    <salesman xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:s="http://www.decisiv.net/platform_api/0.3-beta/Case/Salesman" xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationSalesmen">
        <s:id>id1</s:id>
        <s:name>name1</s:name>
    </salesman>
</salesmen>

List program types for a service location

GET /service_locations/{id}/program_types

Response

<?xml version="1.0" encoding="UTF-8"?>
<programTypes xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationProgramTypes"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:pt="http://www.decisiv.net/platform_api/0.3-beta/Case/ProgramType"
  xsi:schemaLocation="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationProgramTypes">
    <programType xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:pt="http://www.decisiv.net/platform_api/0.3-beta/Case/ProgramType" xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationProgramTypes">
        <pt:description>description0</pt:description>
    </programType>
    <programType xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:pt="http://www.decisiv.net/platform_api/0.3-beta/Case/ProgramType" xmlns="http://www.decisiv.net/platform_api/0.3-beta/Case/ServiceLocationProgramTypes">
        <pt:description>description1</pt:description>
    </programType>
</programTypes>
Sections
Create a case for a service location List departments for a service location Get a single department by code List salesmen for a service location List program types for a service location